Skip to content

docs: Document SQL REPL --expanded flag and .expanded meta-command#1741

Merged
lukekim merged 1 commit into
trunkfrom
docs/sql-repl-expanded-view
May 18, 2026
Merged

docs: Document SQL REPL --expanded flag and .expanded meta-command#1741
lukekim merged 1 commit into
trunkfrom
docs/sql-repl-expanded-view

Conversation

@claudespice
Copy link
Copy Markdown
Collaborator

Summary

Document the expanded view mode shipped for spice sql.

Source PRs

Changes

  • website/docs/cli/reference/sql.md
    • Add -x / --expanded to the spice sql flags list.
    • Add a REPL Meta-commands section documenting .expanded (and the .expanded on / .expanded off variants), similar to PostgreSQL's \x.
    • Add an example showing the -[ RECORD n ]- divider output style.

Test plan

  • cd website && npm run build passes locally
  • Flag and meta-command names verified against the source diff (--expanded/-x, .expanded, .expanded on, .expanded off)

Document the expanded view mode for the SQL REPL shipped in
spiceai/spiceai#10797:

- `-x` / `--expanded` CLI flag to start the REPL in expanded view.
- `.expanded` (and `.expanded on` / `.expanded off`) meta-command for
  toggling at runtime, similar to PostgreSQL's \x.

Useful when tables are wider than the terminal — each column is
rendered on its own line per record.
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 18, 2026

✅ Pull with Spice Passed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
  • ✅ No banned labels detected
  • ✅ Has at least one assignee: claudespice

@github-actions
Copy link
Copy Markdown

🔍 Pull with Spice Failed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
  • ✅ No banned labels detected

Failed checks:

  • ❌ At least one assignee is required for this pull request.

Please address these issues and update your pull request.

1 similar comment
@github-actions
Copy link
Copy Markdown

🔍 Pull with Spice Failed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
  • ✅ No banned labels detected

Failed checks:

  • ❌ At least one assignee is required for this pull request.

Please address these issues and update your pull request.

@github-actions
Copy link
Copy Markdown

🚀 deployed to https://b565f8fb.spiceai-org-website.pages.dev

@claudespice claudespice reopened this May 18, 2026
@github-actions
Copy link
Copy Markdown

🚀 deployed to https://46540437.spiceai-org-website.pages.dev

@lukekim lukekim merged commit b5b8788 into trunk May 18, 2026
10 of 17 checks passed
@lukekim lukekim deleted the docs/sql-repl-expanded-view branch May 18, 2026 22:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants